* @Short_description: Functions to support using cairo
* @Title: Cairo Interaction
*
- * <link href="http://cairographics.org">Cairo</link> is a graphics
+ * [Cairo](http://cairographics.org) is a graphics
* library that supports vector graphics and image compositing that
* can be used with GDK. GTK+ does all of its drawing using cairo.
*
* @GDK_DEVICE_TYPE_FLOATING: Device is a physical device, currently not attached to
* any virtual device.
*
- * Indicates the device type. See <link linkend="GdkDeviceManager.description">above</link>
+ * Indicates the device type. See [above][GdkDeviceManager.description]
* for more information about the meaning of these device types.
*/
typedef enum {
*
* GTK+ provides a higher level abstraction based on top of these functions,
* and so they are not normally needed in GTK+ applications.
- * See the <link linkend="gtk3-Drag-and-Drop">Drag and Drop</link> section of
+ * See the [Drag and Drop][gtk3-Drag-and-Drop] section of
* the GTK+ documentation for more information.
*/
* SECTION:events
* @Short_description: Functions for handling events from the window system
* @Title: Events
- * @See_also: <link linkend="gdk3-Event-Structures">Event Structures</link>
+ * @See_also: [Event Structures][gdk3-Event-Structures]
*
* This section describes functions dealing with events from the window
* system.
* In GTK+ applications the events are handled automatically in
* gtk_main_do_event() and passed on to the appropriate widgets, so these
* functions are rarely needed. Though some of the fields in the
- * <link linkend="gdk3-Event-Structures">Event Structures</link> are useful.
+ * [Event Structures][gdk3-Event-Structures] are useful.
*/
* GDK_PRIORITY_EVENTS:
*
* This is the priority that events from the X server are given in the
- * <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
+ * [GLib Main Loop][glib-The-Main-Event-Loop].
*/
#define GDK_PRIORITY_EVENTS (G_PRIORITY_DEFAULT)
*
* This is the priority that the idle handler processing window updates
* is given in the
- * <link linkend="glib-The-Main-Event-Loop">GLib Main Loop</link>.
+ * [GLib Main Loop][glib-The-Main-Event-Loop].
*/
#define GDK_PRIORITY_REDRAW (G_PRIORITY_HIGH_IDLE + 20)
* can set the text and attributes of it with Pango functions like
* pango_layout_set_text() and get its size with pango_layout_get_size().
* (Note that Pango uses a fixed point system internally, so converting
- * between Pango units and pixels using <link
- * linkend="PANGO-SCALE-CAPS">PANGO_SCALE</link> or the PANGO_PIXELS() macro.)
+ * between Pango units and pixels using [PANGO_SCALE][PANGO-SCALE-CAPS]
+ * or the PANGO_PIXELS() macro.)
*
* Rendering a Pango layout is done most simply with pango_cairo_show_layout();
* you can also draw pieces of the layout with pango_cairo_show_layout_line().
* retrieved by requesting the special target `TARGETS`. When
* a selection is retrieved, the data is accompanied by a type (an atom), and
* a format (an integer, representing the number of bits per item).
- * See <link linkend="gdk3-Properties-and-Atoms">Properties and Atoms</link>
+ * See [Properties and Atoms][gdk3-Properties-and-Atoms]
* for more information.
*
* The functions in this section only contain the lowlevel parts of the
*
* - sensitive (enabled/disabled)
*
- * Apart from regular actions, there are <link linkend="GtkToggleAction">toggle
- * actions</link>, which can be toggled between two states and <link
- * linkend="GtkRadioAction">radio actions</link>, of which only one in a group
+ * Apart from regular actions, there are [toggle actions][GtkToggleAction],
+ * which can be toggled between two states and
+ * [radio actions][GtkRadioAction], of which only one in a group
* can be in the “active” state. Other actions can be implemented as #GtkAction
* subclasses.
*
* @name: the name of the action group.
*
* Creates a new #GtkActionGroup object. The name of the action group
- * is used when associating <link linkend="Action-Accel">keybindings</link>
+ * is used when associating [keybindings][Action-Accel]
* with the actions.
*
* Returns: the new #GtkActionGroup
*
* GtkGradient is a boxed type that represents a gradient.
* It is the result of parsing a
- * <link linkend="gtkcssprovider-gradients">gradient expression</link>.
+ * [gradient expression][gtkcssprovider-gradients].
* To obtain the gradient represented by a GtkGradient, it has to
* be resolved with gtk_gradient_resolve(), which replaces all
* symbolic color references by the colors they refer to (in a given
* it is searched in the directories of the currently open RC files.
*
* GTK+ also tries to load a
- * <link linkend="locale-specific-rc">locale-specific variant</link> of
+ * [locale-specific variant][locale-specific-rc] of
* the included file.
*
* * `module_path path`
*
* * setting = value
*
- * Specifies a value for a <link linkend="GtkSettings">setting</link>.
+ * Specifies a value for a [setting][GtkSettings].
* Note that settings in RC files are overwritten by system-wide settings
* (which are managed by an XSettings manager on X11).
*
*
* * `class::property = value`
*
- * Sets a <link linkend="style-properties">style property</link> for a widget class.
+ * Sets a [style property][style-properties] for a widget class.
*
* The colors and background pixmaps are specified as a function of the
* state of the widget. The states are:
* Each stock ID can be associated with a #GtkStockItem, which contains
* the user-visible label, keyboard accelerator, and translation domain
* of the menu or toolbar item; and/or with an icon stored in a
- * #GtkIconFactory. See <link
- * linkend="gtk3-Themeable-Stock-Images">GtkIconFactory</link> for
+ * #GtkIconFactory. See [GtkIconFactory][gtk3-Themeable-Stock-Images] for
* more information on stock icons. The connection between a
* #GtkStockItem and stock icons is purely conventional (by virtue of
* using the same stock ID); it's possible to register a stock item but
*
* GtkSymbolicColor is a boxed type that represents a symbolic color.
* It is the result of parsing a
- * <link linkend="gtkcssprovider-symbolic-colors">color expression</link>.
+ * [color expression][gtkcssprovider-symbolic-colors].
* To obtain the color represented by a GtkSymbolicColor, it has to
* be resolved with gtk_symbolic_color_resolve(), which replaces all
* symbolic color references by the colors they refer to (in a given
* roughly described by the following DTD.
*
* > Do not confuse the GtkUIManager UI Definitions described here with
- * > the similarly named <link linkend="BUILDER-UI">GtkBuilder UI
- * > Definitions</link>.
+ * > the similarly named [GtkBuilder UI Definitions][BUILDER-UI].
*
* |[
* <!ELEMENT ui (menubar|toolbar|popup|accelerator)* >
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: return location for an error
*
- * Parses a string containing a <link linkend="XML-UI">UI definition</link> and
+ * Parses a string containing a [UI definition][XML-UI] and
* merges it with the current contents of @manager. An enclosing <ui>
* element is added if it is missing.
*
* @filename: (type filename): the name of the file to parse
* @error: return location for an error
*
- * Parses a file containing a <link linkend="XML-UI">UI definition</link> and
+ * Parses a file containing a [UI definition][XML-UI] and
* merges it with the current contents of @manager.
*
* Return value: The merge id for the merged UI. The merge id can be used
* @resource_path: the resource path of the file to parse
* @error: return location for an error
*
- * Parses a resource file containing a <link linkend="XML-UI">UI definition</link> and
+ * Parses a resource file containing a [UI definition][XML-UI] and
* merges it with the current contents of @manager.
*
* Return value: The merge id for the merged UI. The merge id can be used
* gtk_ui_manager_get_ui:
* @manager: a #GtkUIManager
*
- * Creates a <link linkend="XML-UI">UI definition</link> of the merged UI.
+ * Creates a [UI definition][XML-UI] of the merged UI.
*
* Return value: A newly allocated string containing an XML representation of
* the merged UI.
* path may look like: “<Gimp-Toolbox>/File/Dialogs/Tool Options...”.
*
* All accelerators are stored inside one global #GtkAccelMap that can
- * be obtained using gtk_accel_map_get(). See <link
- * linkend="monitoring-changes">Monitoring changes</link> for additional
+ * be obtained using gtk_accel_map_get(). See
+ * [Monitoring changes][monitoring-changes] for additional
* details.
*
* # Manipulating accelerators
*
* The content type of the #GtkAppChooser object.
*
- * See <link linkend="gio-GContentType">GContentType</link>
+ * See [GContentType][gio-GContentType]
* for more information about content types.
*/
pspec = g_param_spec_string ("content-type",
*
* The design of GtkAssistant is that it controls what buttons to show
* and to make sensitive, based on what it knows about the page sequence
- * and the <link linkend="GtkAssistantPageType">type</link> of each page,
+ * and the [type][GtkAssistantPageType] of each page,
* in addition to state information like the page
- * <link linkend="gtk-assistant-set-page-complete">completion</link>
- * and <link linkend="gtk-assistant-commit">committed</link> status.
+ * [completion][gtk-assistant-set-page-complete]
+ * and [committed][gtk-assistant-commit] status.
*
* If you have a case that doesn't quite fit in #GtkAssistants way of
* handling buttons, you can use the #GTK_ASSISTANT_PAGE_CUSTOM page
* A CSS file binding consists of a 'binding-set' definition and a match
* statement to apply the binding set to specific widget types. Details
* on the matching mechanism are described under
- * <link linkend="gtkcssprovider-selectors">Selectors</link>
+ * [Selectors][gtkcssprovider-selectors]
* in the #GtkCssProvider documentation. Inside the binding set
* definition, key combinations are bound to one or more specific
* signal emissions on the target widget. Key combinations are strings
* consisting of an optional #GdkModifierType name and
- * <link linkend="gdk3-Keyboard-Handling">key names</link>
+ * [key names][gdk3-Keyboard-Handling]
* such as those defined in `gdk/gdkkeysyms.h`
* or returned from gdk_keyval_name(), they have to be parsable by
* gtk_accelerator_parse(). Specifications of signal emissions consist
* it provides. Because custom bindings set up in CSS files take
* precedence over the default bindings shipped with GTK+, overriding
* existing bindings as demonstrated in
- * <link linkend="gtk-bindings-install">Installing a key binding</link>
+ * [Installing a key binding][gtk-bindings-install]
* works as expected. The same mechanism can not be used to “unbind”
* existing bindings, however.
*
* @Title: GtkBuildable
*
* GtkBuildable allows objects to extend and customize their deserialization
- * from <link linkend="BUILDER-UI">GtkBuilder UI descriptions</link>.
+ * from [GtkBuilder UI descriptions][BUILDER-UI].
* The interface includes methods for setting names and properties of objects,
* parsing custom tags and constructing child objects.
*
* Gets the name of the @buildable object.
*
* #GtkBuilder sets the name based on the
- * <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+ * [GtkBuilder UI definition][BUILDER-UI]
* used to construct the @buildable.
*
* Returns: the name set with gtk_buildable_set_name()
* @builder: a #GtkBuilder
*
* Called when the builder finishes the parsing of a
- * <link linkend="BUILDER-UI">GtkBuilder UI definition</link>.
+ * [GtkBuilder UI definition][BUILDER-UI].
* Note that this will be called once for each time
* gtk_builder_add_from_file() or gtk_builder_add_from_string()
* is called on a builder.
* “GtkBuilder UI definitions” or just
* “UI definitions” if the context is clear.
* Do not confuse GtkBuilder UI Definitions with
- * <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which
+ * [GtkUIManager UI Definitions][XML-UI], which
* are more limited in scope. It is common to use `.ui`
* as the filename extension for files containing GtkBuilder UI
* definitions.
* @filename: the name of the file to parse
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> and merges it with the current contents of @builder.
+ * Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
+ * and merges it with the current contents of @builder.
*
* Most users will probably want to use gtk_builder_new_from_file().
- *
+ *
* Upon errors 0 will be returned and @error will be assigned a
* #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
* domain.
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a file containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> building only the requested objects and merges
- * them with the current contents of @builder.
+ * Parses a file containing a [GtkBuilder UI definition][BUILDER-UI]
+ * building only the requested objects and merges
+ * them with the current contents of @builder.
*
* Upon errors 0 will be returned and @error will be assigned a
* #GError from the #GTK_BUILDER_ERROR, #G_MARKUP_ERROR or #G_FILE_ERROR
* @resource_path: the path of the resource file to parse
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> and merges it with the current contents of @builder.
+ * Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
+ * and merges it with the current contents of @builder.
*
* Most users will probably want to use gtk_builder_new_from_resource().
*
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a resource file containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> building only the requested objects and merges
+ * Parses a resource file containing a [GtkBuilder UI definition][BUILDER-UI]
+ * building only the requested objects and merges
* them with the current contents of @builder.
*
* Upon errors 0 will be returned and @error will be assigned a
* @length: the length of @buffer (may be -1 if @buffer is nul-terminated)
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> and merges it with the current contents of @builder.
+ * Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
+ * and merges it with the current contents of @builder.
*
* Most users will probably want to use gtk_builder_new_from_string().
*
* @object_ids: (array zero-terminated=1) (element-type utf8): nul-terminated array of objects to build
* @error: (allow-none): return location for an error, or %NULL
*
- * Parses a string containing a <link linkend="BUILDER-UI">GtkBuilder
- * UI definition</link> building only the requested objects and merges
+ * Parses a string containing a [GtkBuilder UI definition][BUILDER-UI]
+ * building only the requested objects and merges
* them with the current contents of @builder.
*
* Upon errors 0 will be returned and @error will be assigned a
* gtk_builder_new_from_file:
* @filename: filename of user interface description file
*
- * Builds the <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+ * Builds the [GtkBuilder UI definition][BUILDER-UI]
* in the file @filename.
*
* If there is an error opening the file or parsing the description then
* gtk_builder_new_from_resource:
* @resource_path: a #GResource resource path
*
- * Builds the <link linkend="BUILDER-UI">GtkBuilder UI definition</link>
+ * Builds the [GtkBuilder UI definition][BUILDER-UI]
* at @resource_path.
*
* If there is an error locating the resurce or parsing the description
* @string: a user interface (XML) description
* @length: the length of @string, or -1
*
- * Builds the user interface described by @string (in the <link
- * linkend="BUILDER-UI">GtkBuilder UI definition</link> format).
+ * Builds the user interface described by @string (in the
+ * [GtkBuilder UI definition][BUILDER-UI] format).
*
* If @string is %NULL-terminated then @length should be -1. If @length
* is not -1 then it is the length of @string.
*
* # Requesting area sizes
*
- * As outlined in <link linkend="geometry-management">GtkWidget's
- * geometry management section</link>, GTK+ uses a height-for-width
+ * As outlined in
+ * [GtkWidget's geometry management section][geometry-management],
+ * GTK+ uses a height-for-width
* geometry management system to compute the sizes of widgets and user
* interfaces. #GtkCellArea uses the same semantics to calculate the
* size of an area for an arbitrary number of #GtkTreeModel rows.
*
* The #GtkCellArea introduces cell properties for #GtkCellRenderers
* in very much the same way that #GtkContainer introduces
- * <link linkend="child-properties">child properties</link>
+ * [child properties][child-properties]
* for #GtkWidgets. This provides some general interfaces for defining
* the relationship cell areas have with their cells. For instance in a
* #GtkCellAreaBox a cell might “expand” and receive extra space when
*
* Furthermore for implementations of GtkCellLayout that use a
* #GtkCellArea to lay out cells (all GtkCellLayouts in GTK+ use
- * a GtkCellArea) <link linkend="cell-properties">cell properties</link>
+ * a GtkCellArea) [cell properties][cell-properties]
* can also be defined in the format by specifying the custom
* <cell-packing> attribute which can contain multiple
* <property> elements defined in the normal way.
*
* Creates a new #GtkCellView widget, adds a #GtkCellRendererText
* to it, and makes it show @markup. The text can be
- * marked up with the <link linkend="PangoMarkupFormat">Pango text
- * markup language</link>.
+ * marked up with the [Pango text markup language][PangoMarkupFormat].
*
* Return value: A newly created #GtkCellView widget.
*
* @scroll_type: a #GtkScrollType
*
* The ::move-active signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to move the active selection.
*
* Since: 2.12
* @widget: the object that received the signal
*
* The ::popup signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to popup the combo box list.
*
* The default binding for this signal is Alt+Down.
* @button: the object which received the signal
*
* The ::popdown signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to popdown the combo box list.
*
* The default bindings for this signal are Alt+Up and Escape.
* that the container adds. Then vertical expand space should be added where appropriate and available
* and the container should go on to actually allocating the child widgets.
*
- * See <link linkend="geometry-management">GtkWidget's geometry management section</link>
+ * See [GtkWidget's geometry management section][geometry-management]
* to learn more about implementing height-for-width geometry management for widgets.
*
* # Child properties
* the class of @container
*
* Emits a #GtkWidget::child-notify signal for the
- * <link linkend="child-properties">child property</link>
+ * [child property][child-properties]
* @child_property on widget.
*
* This is an analogue of g_object_notify() for child properties.
* GtkDialog::close:
*
* The ::close signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user uses a keybinding to close
* the dialog.
*
*
* As well as the functions listed here, applications
* may need to use some facilities provided for
- * <link linkend="gtk3-Selections">Selections</link>.
+ * [Selections][gtk3-Selections].
* Also, the Drag and Drop API makes use of signals
* in the #GtkWidget class.
*/
* gdk_window_invalidate_rect() are equally good ways to do this.
* You'll then get a draw signal for the invalid region.
*
- * The available routines for drawing are documented on the <link
- * linkend="gdk3-Cairo-Interaction">GDK Drawing Primitives</link> page
+ * The available routines for drawing are documented on the
+ * [GDK Drawing Primitives][gdk3-Cairo-Interaction] page
* and the cairo documentation.
*
* To receive mouse events on a drawing area, you will need to enable
* GtkEntry:primary-icon-tooltip-markup:
*
* The contents of the tooltip on the primary icon, which is marked up
- * with the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>.
+ * with the [Pango text markup language][PangoMarkupFormat].
*
* Also see gtk_entry_set_icon_tooltip_markup().
*
* GtkEntry:secondary-icon-tooltip-markup:
*
* The contents of the tooltip on the secondary icon, which is marked up
- * with the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>.
+ * with the [Pango text markup language][PangoMarkupFormat].
*
* Also see gtk_entry_set_icon_tooltip_markup().
*
* the Enter key.
*
* While this signal is used as a
- * <link linkend="keybinding-signals">keybinding signal</link>,
+ * [keybinding signal][keybinding-signals],
* it is also commonly used by applications to intercept
* activation of entries.
*
* @extend_selection: %TRUE if the move should extend the selection
*
* The ::move-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a cursor movement.
* If the cursor is not visible in @entry, this signal causes
* the viewport to be moved instead.
* @string: the string to insert
*
* The ::insert-at-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates the insertion of a
* fixed string at the cursor.
*
* @count: the number of @type units to delete
*
* The ::delete-from-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a text deletion.
*
* If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection
* @entry: the object which received the signal
*
* The ::backspace signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* The default bindings for this signal are
* @entry: the object which received the signal
*
* The ::cut-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to cut the selection to the clipboard.
*
* The default bindings for this signal are
* @entry: the object which received the signal
*
* The ::copy-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to copy the selection to the clipboard.
*
* The default bindings for this signal are
* @entry: the object which received the signal
*
* The ::paste-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to paste the contents of the clipboard
* into the text view.
*
* @entry: the object which received the signal
*
* The ::toggle-overwrite signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to toggle the overwrite mode of the entry.
*
* The default bindings for this signal is Insert.
*
* Sets @tooltip as the contents of the tooltip for the icon at
* the specified position. @tooltip is assumed to be marked up with
- * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * the [Pango text markup language][PangoMarkupFormat].
*
* Use %NULL for @tooltip to remove an existing tooltip.
*
* Determines whether the completions popup window will shown
* for a single possible completion. You probably want to set
* this to %FALSE if you are using
- * <link linkend="GtkEntryCompletion--inline-completion">inline
- * completion</link>.
+ * [inline completion][GtkEntryCompletion--inline-completion].
*
* Since: 2.8
*/
*
* Sets whether the completion popup window will appear even if there is
* only a single match. You may want to set this to %FALSE if you
- * are using <link linkend="GtkEntryCompletion--inline-completion">inline
- * completion</link>.
+ * are using [inline completion][GtkEntryCompletion--inline-completion].
*
* Since: 2.8
*/
* @expander: a #GtkExpander
* @use_markup: %TRUE if the label's text should be parsed for markup
*
- * Sets whether the text of the label contains markup in <link
- * linkend="PangoMarkupFormat">Pango's text markup
- * language</link>. See gtk_label_set_markup().
+ * Sets whether the text of the label contains markup in
+ * [Pango's text markup language][PangoMarkupFormat].
+ * See gtk_label_set_markup().
*
* Since: 2.4
*/
* @expander: a #GtkExpander
*
* Returns whether the label's text is interpreted as marked up with
- * the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>. See gtk_expander_set_use_markup().
+ * the [Pango text markup language][PangoMarkupFormat].
+ * See gtk_expander_set_use_markup().
*
* Return value: %TRUE if the label's text will be parsed for markup
*
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
- * In general, you should not use this function. See the <link
- * linkend="gtkfilechooserdialog-setting-up">section on setting up a file
- * chooser dialog</link> for the rationale behind this.
+ * In general, you should not use this function. See the
+ * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
+ * for the rationale behind this.
*
* Return value: Not useful.
*
* The user will be shown the full contents of the current folder,
* plus user interface elements for navigating to other folders.
*
- * In general, you should not use this function. See the <link
- * linkend="gtkfilechooserdialog-setting-up">section on setting up a file
- * chooser dialog</link> for the rationale behind this.
+ * In general, you should not use this function. See the
+ * [section on setting up a file chooser dialog][gtkfilechooserdialog-setting-up]
+ * for the rationale behind this.
*
* Return value: %TRUE if the folder could be changed successfully, %FALSE
* otherwise.
* appropriate.
*
* To summarize, make sure you use a
- * <link linkend="gtkfilechooserdialog-responses">stock response code</link>
+ * [stock response code][gtkfilechooserdialog-responses]
* when you use #GtkFileChooserDialog to ensure proper operation.
*/
* name.
*
* The ::location-popup signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show a "Location"
* @widget: the object which received the signal.
*
* The ::location-popup-on-paste signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show a "Location"
* @widget: the object which received the signal.
*
* The ::location-toggle-popup signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to toggle the visibility of a "Location"
* @widget: the object which received the signal.
*
* The ::up-folder signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser go to the parent of
* @widget: the object which received the signal.
*
* The ::down-folder signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser go to a child of the
* @widget: the object which received the signal.
*
* The ::home-folder signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show the user's home
* @widget: the object which received the signal.
*
* The ::desktop-folder signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show the user's Desktop
* @bookmark_index: the number of the bookmark to switch to
*
* The ::quick-bookmark signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser switch to the bookmark
* @widget: the object which received the signal.
*
* The ::show-hidden signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser display hidden files.
* @widget: the object which received the signal.
*
* The ::search-shortcut signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show the search entry.
* @widget: the object which received the signal.
*
* The ::recent-shortcut signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* This is used to make the file chooser show the Recent location.
* double-clicking, or by using the Space or Enter key.
*
* While this signal is used as a
- * <link linkend="keybinding-signals">keybinding signal</link>,
+ * [keybinding signal][keybinding-signals],
* it can be used by applications for their own purposes.
*/
child_signals[CHILD_ACTIVATE] =
* @box: the #GtkFlowBox on which the signal is emitted
*
* The ::activate-cursor-child signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user activates the @box.
*/
signals[ACTIVATE_CURSOR_CHILD] = g_signal_new ("activate-cursor-child",
* @box: the #GtkFlowBox on which the signal is emitted
*
* The ::toggle-cursor-child signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which toggles the selection of the child that has the focus.
*
* The default binding for this signal is Ctrl-Space.
* @count: the number of @step units to move
*
* The ::move-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a cursor movement.
* If the cursor is not visible in @text_view, this signal causes
* the viewport to be moved instead.
* @box: the #GtkFlowBox on which the signal is emitted
*
* The ::select-all signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to select all children of the box, if
* the selection mode permits it.
*
* @box: the #GtkFlowBox on which the signal is emitted
*
* The ::unselect-all signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to unselect all children of the box, if
* the selection mode permits it.
*
* rows and columns. It is a very similar to #GtkTable and #GtkBox,
* but it consistently uses #GtkWidget's #GtkWidget:margin and #GtkWidget:expand
* properties instead of custom child properties, and it fully supports
- * <link linkend="geometry-management">height-for-width geometry management</link>.
+ * [height-for-width geometry management][geometry-management].
*
* Children are added using gtk_grid_attach(). They can span multiple
* rows or columns. It is also possible to add a child next to an
* GtkIconView::select-all:
* @iconview: the object on which the signal is emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user selects all items.
*
* Applications should not connect to it, but may emit it with
* GtkIconView::unselect-all:
* @iconview: the object on which the signal is emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user unselects all items.
*
* Applications should not connect to it, but may emit it with
* GtkIconView::select-cursor-item:
* @iconview: the object on which the signal is emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user selects the item that is currently
* focused.
*
* GtkIconView::toggle-cursor-item:
* @iconview: the object on which the signal is emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user toggles whether the currently
* focused item is selected or not. The exact effect of this
* depend on the selection mode.
* GtkIconView::activate-cursor-item:
* @iconview: the object on which the signal is emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user activates the currently
* focused item.
*
* @count: the number of @step units to move
*
* The ::move-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a cursor movement.
*
* Applications should not connect to it, but may emit it with
*
* After a new loadable input method module has been installed on the system,
* the configuration file `gtk.immodules` needs to be
- * regenerated by <link linkend="gtk-query-immodules-3.0">gtk-query-immodules-3.0</link>,
+ * regenerated by [gtk-query-immodules-3.0][gtk-query-immodules-3.0],
* in order for the new input method to become available to GTK+ applications.
*/
* GtkInfoBar::close:
*
* The ::close signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user uses a keybinding to dismiss
* the info bar.
*
* # Markup (styled text)
*
* To make it easy to format text in a label (changing colors,
- * fonts, etc.), label text can be provided in a simple <link
- * linkend="PangoMarkupFormat">markup format</link>.
+ * fonts, etc.), label text can be provided in a simple
+ * [markup format][PangoMarkupFormat].
*
* Here's how to create a label with a small font:
* |[<!-- language="C" -->
* gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>");
* ]|
*
- * (See <link
- * linkend="PangoMarkupFormat">complete documentation</link> of available
+ * (See [complete documentation][PangoMarkupFormat] of available
* tags in the Pango manual.)
*
* The markup passed to gtk_label_set_markup() must be valid; for example,
*
* Note that the interpretation of #GtkLabel:width-chars and
* #GtkLabel:max-width-chars has changed a bit with the introduction of
- * <link linkend="geometry-management">width-for-height geometry management.</link>
+ * [width-for-height geometry management.][geometry-management]
*
* # Links
*
* @extend_selection: %TRUE if the move should extend the selection
*
* The ::move-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a cursor movement.
* If the cursor is not visible in @entry, this signal causes
* the viewport to be moved instead.
* @label: the object which received the signal
*
* The ::copy-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to copy the selection to the clipboard.
*
* The default binding for this signal is Ctrl-c.
* GtkLabel::activate-current-link:
* @label: The label on which the signal was emitted
*
- * A <link linkend="keybinding-signals">keybinding signal</link>
+ * A [keybinding signal][keybinding-signals]
* which gets emitted when the user activates a link in the label.
*
* Applications may also emit the signal with g_signal_emit_by_name()
* The desired width of the label, in characters. If this property is set to
* -1, the width will be calculated automatically.
*
- * See the section on <link linkend="label-text-layout">text layout</link>
+ * See the section on [text layout][label-text-layout]
* for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
* determine the width of ellipsized and wrapped labels.
*
* The desired maximum width of the label, in characters. If this property
* is set to -1, the width will be calculated automatically.
*
- * See the section on <link linkend="label-text-layout">text layout</link>
+ * See the section on [text layout][label-text-layout]
* for details of how #GtkLabel:width-chars and #GtkLabel:max-width-chars
* determine the width of ellipsized and wrapped labels.
*
/**
* gtk_label_set_markup:
* @label: a #GtkLabel
- * @str: a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
- *
- * Parses @str which is marked up with the <link
- * linkend="PangoMarkupFormat">Pango text markup language</link>, setting the
+ * @str: a markup string (see [Pango markup format][PangoMarkupFormat])
+ *
+ * Parses @str which is marked up with the
+ * [Pango text markup language][PangoMarkupFormat], setting the
* label's text and attribute list based on the parse results. If the @str is
* external data, you may need to escape it with g_markup_escape_text() or
* g_markup_printf_escaped()<!-- -->:
* gtk_label_set_markup_with_mnemonic:
* @label: a #GtkLabel
* @str: a markup string (see
- * <link linkend="PangoMarkupFormat">Pango markup format</link>)
+ * [Pango markup format][PangoMarkupFormat])
*
* Parses @str which is marked up with the
- * <link linkend="PangoMarkupFormat">Pango text markup language</link>,
+ * [Pango text markup language][PangoMarkupFormat],
* setting the label's text and attribute list based on the parse results.
* If characters in @str are preceded by an underscore, they are underlined
* indicating that they represent a keyboard accelerator called a mnemonic.
* @label: a #GtkLabel
* @setting: %TRUE if the label's text should be parsed for markup.
*
- * Sets whether the text of the label contains markup in <link
- * linkend="PangoMarkupFormat">Pango's text markup
- * language</link>. See gtk_label_set_markup().
+ * Sets whether the text of the label contains markup in
+ * [Pango's text markup language][PangoMarkupFormat].
+ * See gtk_label_set_markup().
**/
void
gtk_label_set_use_markup (GtkLabel *label,
* @label: a #GtkLabel
*
* Returns whether the label's text is interpreted as marked up with
- * the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>. See gtk_label_set_use_markup ().
+ * the [Pango text markup language][PangoMarkupFormat].
+ * See gtk_label_set_use_markup ().
*
* Return value: %TRUE if the label's text will be parsed for markup.
**/
* can use all of the methods available there. It also implements the
* #GtkTreeSortable interface so it can be sorted by the view.
* Finally, it also implements the tree
- * <link linkend="gtk3-GtkTreeView-drag-and-drop">drag and drop</link>
+ * [drag and drop][gtk3-GtkTreeView-drag-and-drop]
* interfaces.
*
* The #GtkListStore can accept most GObject types as a column type, though
*
* Creates a new message dialog, which is a simple dialog with an icon
* indicating the dialog type (error, warning, etc.) and some text which
- * is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * is marked up with the [Pango text markup language][PangoMarkupFormat].
* When the user clicks a button a “response” signal is emitted with
* response IDs from #GtkResponseType. See #GtkDialog for more details.
*
/**
* gtk_message_dialog_set_markup:
* @message_dialog: a #GtkMessageDialog
- * @str: markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
+ * @str: markup string (see [Pango markup format][PangoMarkupFormat])
*
* Sets the text of the message dialog to be @str, which is marked
- * up with the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>.
+ * up with the [Pango text markup language][PangoMarkupFormat].
*
* Since: 2.4
**/
* gtk_message_dialog_format_secondary_markup:
* @message_dialog: a #GtkMessageDialog
* @message_format: printf()-style markup string (see
- <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
+ [Pango markup format][PangoMarkupFormat]), or %NULL
* @...: arguments for @message_format
*
* Sets the secondary text of the message dialog to be @message_format (with
* printf()-style), which is marked up with the
- * <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * [Pango text markup language][PangoMarkupFormat].
*
* Due to an oversight, this function does not escape special XML characters
* like gtk_message_dialog_new_with_markup() does. Thus, if the arguments
* #GtkPageSetupUnixDialog implements a page setup dialog for platforms
* which don't provide a native page setup dialog, like Unix. It can
* be used very much like any other GTK+ dialog, at the cost of
- * the portability offered by the <link
- * linkend="gtk3-High-level-Printing-API">high-level printing API</link>
+ * the portability offered by the
+ * [high-level printing API][gtk3-High-level-Printing-API]
*
* Printing support was added in GTK+ 2.10.
*/
* @reversed: whether cycling backward or forward
*
* The ::cycle-child-focus signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to cycle the focus between the children of the paned.
*
* The default binding is f6.
* @widget: the object that received the signal
*
* The ::toggle-handle-focus is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to accept the current position of the handle and then
* move focus to the next widget in the focus chain.
*
* @scroll_type: a #GtkScrollType
*
* The ::move-handle signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to move the handle when the user is using key bindings
* to move it.
*
* @reversed: whether cycling backward or forward
*
* The ::cycle-handle-focus signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to cycle whether the paned should grab focus to allow
* the user to change position of the handle by using key bindings.
*
* @widget: the object that received the signal
*
* The ::accept-position signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to accept the current position of the handle when
* moving it using key bindings.
*
* @widget: the object that received the signal
*
* The ::cancel-position signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to cancel moving the position of the handle using key
* bindings. The position of the handle will be reset to the value prior to
* moving it.
*
* The #GtkPaperSize object stores not only the dimensions (width
* and height) of a paper size and its name, it also provides
- * default <link linkend="print-margins">print margins</link>.
+ * default [print margins][print-margins].
*
* Printing support has been added in GTK+ 2.10.
*/
* which don't provide a native print dialog, like Unix. It can
* be used very much like any other GTK+ dialog, at the cost of
* the portability offered by the
- * <link linkend="gtk3-High-level-Printing-API">high-level printing API</link>
+ * [high-level printing API][gtk3-High-level-Printing-API]
*
* In order to print something with #GtkPrintUnixDialog, you need
* to use gtk_print_unix_dialog_get_selected_printer() to obtain
* and %GTK_POS_LEFT are drawn above the scale, anything else below.
* For a vertical scale, #GTK_POS_LEFT and %GTK_POS_TOP are drawn to
* the left of the scale, anything else to the right.
- * @markup: (allow-none): Text to be shown at the mark, using <link linkend="PangoMarkupFormat">Pango markup</link>, or %NULL
+ * @markup: (allow-none): Text to be shown at the mark, using [Pango markup][PangoMarkupFormat], or %NULL
*
*
* Adds a mark at @value.
* @button: the object which received the signal
*
* The ::popup signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to popup the scale widget.
*
* The default bindings for this signal are Space, Enter and Return.
* @button: the object which received the signal
*
* The ::popdown signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to popdown the scale widget.
*
* The default binding for this signal is Escape.
* horizontally or not
*
* The ::scroll-child signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when a keybinding that scrolls is pressed.
* The horizontal or vertical adjustment is updated which triggers a
* signal that the scrolled windows child may listen to and scroll itself.
* @direction_type: either %GTK_DIR_TAB_FORWARD or
* %GTK_DIR_TAB_BACKWARD
*
- * The ::move-focus-out signal is a <link
- * linkend="keybinding-signals">keybinding signal</link> which gets
+ * The ::move-focus-out signal is a
+ * [keybinding signal][keybinding-signals] which gets
* emitted when focus is moved away from the scrolled window by a
* keybinding. The #GtkWidget::move-focus signal is emitted with
* @direction_type on this scrolled windows toplevel parent in the
* ...
* ]|
* Color names must be acceptable as identifiers in the
- * <link linkend="gtk3-Resource-Files">gtkrc</link> syntax, and
+ * [gtkrc][gtk3-Resource-Files] syntax, and
* color specifications must be in the format accepted by
* gdk_color_parse().
*
* GtkStatusIcon:tooltip-markup:
*
* Sets the text of tooltip to be the given string, which is marked up
- * with the <link linkend="PangoMarkupFormat">Pango text markup
- * language</link>. Also see gtk_tooltip_set_markup().
+ * with the [Pango text markup language][PangoMarkupFormat].
+ * Also see gtk_tooltip_set_markup().
*
* This is a convenience property which will take care of getting the
* tooltip shown if the given string is not %NULL.
* @markup: (allow-none): the contents of the tooltip for @status_icon, or %NULL
*
* Sets @markup as the contents of the tooltip, which is marked up with
- * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * the [Pango text markup language][PangoMarkupFormat].
*
* This function will take care of setting #GtkStatusIcon:has-tooltip to %TRUE
* and of the default handler for the #GtkStatusIcon::query-tooltip signal.
* @Title: GtkTextBuffer
* @See_also: #GtkTextView, #GtkTextIter, #GtkTextMark
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and data
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and data
* types related to the text widget and how they work together.
*/
* @Short_description: Text buffer iterator
* @Title: GtkTextIter
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and data
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and data
* types related to the text widget and how they work together.
*/
* @Short_description: A position in the buffer preserved across buffer modifications
* @Title: GtkTextMark
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and data
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and data
* types related to the text widget and how they work together.
*
* A #GtkTextMark is like a bookmark in a text buffer; it preserves a position in
* @Title: GtkTextTag
* @Short_description: A tag that can be applied to text in a GtkTextBuffer
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and
* data types related to the text widget and how they work together.
*
* Tags should be in the #GtkTextTagTable for a given #GtkTextBuffer
* @Short_description: Collection of tags that can be used together
* @Title: GtkTextTagTable
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and
* data types related to the text widget and how they work together.
*
* # GtkTextTagTables as GtkBuildable
* @Title: GtkTextView
* @See_also: #GtkTextBuffer, #GtkTextIter
*
- * You may wish to begin by reading the <link linkend="TextWidget">text widget
- * conceptual overview</link> which gives an overview of all the objects and data
+ * You may wish to begin by reading the
+ * [text widget conceptual overview][TextWidget]
+ * which gives an overview of all the objects and data
* types related to the text widget and how they work together.
*/
* @extend_selection: %TRUE if the move should extend the selection
*
* The ::move-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a cursor movement.
* If the cursor is not visible in @text_view, this signal causes
* the viewport to be moved instead.
* @count: the number of @step units to move
*
* The ::move-viewport signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which can be bound to key combinations to allow the user
* to move the viewport, i.e. change what part of the text view
* is visible in a containing scrolled window.
* @text_view: the object which received the signal
*
* The ::set-anchor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates setting the "anchor"
* mark. The "anchor" mark gets placed at the same position as the
* "insert" mark.
* @string: the string to insert
*
* The ::insert-at-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates the insertion of a
* fixed string at the cursor.
*
* @count: the number of @type units to delete
*
* The ::delete-from-cursor signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user initiates a text deletion.
*
* If the @type is %GTK_DELETE_CHARS, GTK+ deletes the selection
* @text_view: the object which received the signal
*
* The ::backspace signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user asks for it.
*
* The default bindings for this signal are
* @text_view: the object which received the signal
*
* The ::cut-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to cut the selection to the clipboard.
*
* The default bindings for this signal are
* @text_view: the object which received the signal
*
* The ::copy-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to copy the selection to the clipboard.
*
* The default bindings for this signal are
* @text_view: the object which received the signal
*
* The ::paste-clipboard signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to paste the contents of the clipboard
* into the text view.
*
* @text_view: the object which received the signal
*
* The ::toggle-overwrite signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to toggle the overwrite mode of the text view.
*
* The default bindings for this signal is Insert.
* @select: %TRUE to select, %FALSE to unselect
*
* The ::select-all signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to select or unselect the complete
* contents of the text view.
*
* @text_view: the object which received the signal
*
* The ::toggle-cursor-visible signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted to toggle the visibility of the cursor.
*
* The default binding for this signal is F7.
/**
* gtk_tooltip_set_markup:
* @tooltip: a #GtkTooltip
- * @markup: (allow-none): a markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>) or %NULL
+ * @markup: (allow-none): a markup string (see [Pango markup format][PangoMarkupFormat]) or %NULL
*
* Sets the text of the tooltip to be @markup, which is marked up
- * with the <link
- * linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * with the [Pango text markup language][PangoMarkupFormat].
* If @markup is %NULL, the label will be hidden.
*
* Since: 2.12
* @Title: GtkTreeModel
* @Short_description: The tree interface used by GtkTreeView
* @See_also: #GtkTreeView, #GtkTreeStore, #GtkListStore,
- * <link linkend="gtk3-GtkTreeView-drag-and-drop">GtkTreeView drag-and-drop</link>
+ * [GtkTreeView drag-and-drop][gtk3-GtkTreeView-drag-and-drop]
* #GtkTreeSortable
*
* The #GtkTreeModel interface defines a generic tree interface for
* @See_also: #GtkTreeView, #GtkTreeViewColumn, #GtkTreeModel,
* #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore,
* #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf,
- * #GtkCellRendererText, #GtkCellRendererToggle, <link linkend="gtk3-GtkTreeView-drag-and-drop">GtkTreeView drag-and-drop</link>
+ * #GtkCellRendererText, #GtkCellRendererToggle, [GtkTreeView drag-and-drop][gtk3-GtkTreeView-drag-and-drop]
*
* The #GtkTreeSelection object is a helper object to manage the selection
* for a #GtkTreeView widget. The #GtkTreeSelection object is
* can use all of the methods available there. It also implements the
* #GtkTreeSortable interface so it can be sorted by the view. Finally,
* it also implements the tree
- * <link linkend="gtk3-GtkTreeView-drag-and-drop">drag and drop</link>
+ * [drag and drop][gtk3-GtkTreeView-drag-and-drop]
* interfaces.
*
* # GtkTreeStore as GtkBuildable
* @Short_description: A widget for displaying both trees and lists
* @Title: GtkTreeView
* @See_also: #GtkTreeViewColumn, #GtkTreeSelection, #GtkTreeModel,
- * <link linkend="gtk3-GtkTreeView-drag-and-drop">GtkTreeView drag-and-drop</link>,
+ * [GtkTreeView drag-and-drop][gtk3-GtkTreeView-drag-and-drop],
* #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore,
* #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf,
* #GtkCellRendererText, #GtkCellRendererToggle
*
* Widget that displays any object that implements the #GtkTreeModel interface.
*
- * Please refer to the <link linkend="TreeWidget">tree widget conceptual
- * overview</link> for an overview of all the objects and data types related
+ * Please refer to the
+ * [tree widget conceptual overview][TreeWidget]
+ * for an overview of all the objects and data types related
* to the tree widget and how they work together.
*
* Several different coordinate systems are exposed in the GtkTreeView API.
* the "activate-on-single-click" property set to %TRUE. It is also
* emitted when a non-editable row is selected and one of the keys:
* Space, Shift+Space, Return or Enter is pressed.
- *
- * For selection handling refer to the <link linkend="TreeWidget">tree
- * widget conceptual overview</link> as well as #GtkTreeSelection.
+ *
+ * For selection handling refer to the
+ * [tree widget conceptual overview][TreeWidget]
+ * as well as #GtkTreeSelection.
*/
tree_view_signals[ROW_ACTIVATED] =
g_signal_new (I_("row-activated"),
* @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeModel, #GtkTreeSortable,
* #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable,
* #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle,
- * <link linkend="gtk3-GtkTreeView-drag-and-drop">GtkTreeView drag-and-drop</link>
+ * [GtkTreeView drag-and-drop][gtk3-GtkTreeView-drag-and-drop]
*
* The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget.
* It allows to set properties of the column header, and functions as a holding pen for
* the cell renderers which determine how the data in the column is displayed.
*
- * Please refer to the <link linkend="TreeWidget">tree widget conceptual overview</link>
+ * Please refer to the [tree widget conceptual overview][TreeWidget]
* for an overview of all the objects and data types related to the tree widget and how
* they work together.
*/
* requested. For this reason, #GtkWidget caches a small number of results
* to avoid re-querying for the same sizes in one allocation cycle.
*
- * See <link linkend="container-geometry-management">GtkContainer's
- * geometry management section</link>
+ * See
+ * [GtkContainer's geometry management section][container-geometry-management]
* to learn more about how height-for-width allocations are performed
* by container widgets.
*
* #GtkWidget introduces “style
* properties” - these are basically object properties that are stored
* not on the object, but in the style object associated to the widget. Style
- * properties are set in <link linkend="gtk3-Resource-Files">resource files</link>.
+ * properties are set in [resource files][gtk3-Resource-Files].
* This mechanism is used for configuring such things as the location of the
* scrollbar arrows through the theme, giving theme authors more control over the
* look of applications without the need to write a theme engine in C.
* GtkWidget:tooltip-markup:
*
* Sets the text of tooltip to be the given string, which is marked up
- * with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * with the [Pango text markup language][PangoMarkupFormat].
* Also see gtk_tooltip_set_markup().
*
* This is a convenience property which will take care of getting the
* @child_property: the #GParamSpec of the changed child property
*
* The ::child-notify signal is emitted for each
- * <link linkend="child-properties">child property</link> that has
+ * [child property][child-properties] that has
* changed on an object. The signal's detail holds the property name.
*/
widget_signals[CHILD_NOTIFY] =
* class of @widget<!-- -->'s parent
*
* Emits a #GtkWidget::child-notify signal for the
- * <link linkend="child-properties">child property</link> @child_property
+ * [child property][child-properties] @child_property
* on @widget.
*
* This is the analogue of g_object_notify() for child properties.
* @markup: (allow-none): the contents of the tooltip for @widget, or %NULL
*
* Sets @markup as the contents of the tooltip, which is marked up with
- * the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
+ * the [Pango text markup language][PangoMarkupFormat].
*
* This function will take care of setting #GtkWidget:has-tooltip to %TRUE
* and of the default handler for the #GtkWidget::query-tooltip signal.
* @window: the window which received the signal
*
* The ::activate-focus signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user activates the currently
* focused widget of @window.
*/
* @window: the window which received the signal
*
* The ::activate-default signal is a
- * <link linkend="keybinding-signals">keybinding signal</link>
+ * [keybinding signal][keybinding-signals]
* which gets emitted when the user activates the default widget
* of @window.
*/
* you might use #GTK_WINDOW_POPUP. #GTK_WINDOW_POPUP is not for
* dialogs, though in some other toolkits dialogs are called “popups”.
* In GTK+, #GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip.
- * On X11, popup windows are not controlled by the <link
- * linkend="gtk-X11-arch">window manager</link>.
+ * On X11, popup windows are not controlled by the
+ * [window manager][gtk-X11-arch].
*
* If you simply want an undecorated window (no window borders), use
* gtk_window_set_decorated(), don't use #GTK_WINDOW_POPUP.
*
* Sets the title of the #GtkWindow. The title of a window will be
* displayed in its title bar; on the X Window System, the title bar
- * is rendered by the <link linkend="gtk-X11-arch">window
- * manager</link>, so exactly how the title appears to users may vary
+ * is rendered by the [window manager][gtk-X11-arch],
+ * so exactly how the title appears to users may vary
* according to a user's exact configuration. The title should help a
* user distinguish this window from other windows they may have
* open. A good title might include the application name and current
* This function is only useful on X11, not with other GTK+ targets.
*
* In combination with the window title, the window role allows a
- * <link linkend="gtk-X11-arch">window manager</link> to identify "the
+ * [window manager][gtk-X11-arch] to identify "the
* same" window when an application is restarted. So for example you
* might set the “toolbox” role on your app's toolbox window, so that
* when the user restarts their session, the window manager can put
* with other windows in the same application. To keep modal dialogs
* on top of main application windows, use
* gtk_window_set_transient_for() to make the dialog transient for the
- * parent; most <link linkend="gtk-X11-arch">window managers</link>
+ * parent; most [window managers][gtk-X11-arch]
* will then disallow lowering the dialog below the parent.
*
*
* @parent: (allow-none): parent window, or %NULL
*
* Dialog windows should be set transient for the main application
- * window they were spawned from. This allows <link
- * linkend="gtk-X11-arch">window managers</link> to e.g. keep the
+ * window they were spawned from. This allows
+ * [window managers][gtk-X11-arch] to e.g. keep the
* dialog on top of the main window, or center the dialog over the
* main window. gtk_dialog_new_with_buttons() and other convenience
* functions in GTK+ will sometimes call
* @setting: %TRUE to decorate the window
*
* By default, windows are decorated with a title bar, resize
- * controls, etc. Some <link linkend="gtk-X11-arch">window
- * managers</link> allow GTK+ to disable these decorations, creating a
+ * controls, etc. Some [window managers][gtk-X11-arch]
+ * allow GTK+ to disable these decorations, creating a
* borderless window. If you set the decorated property to %FALSE
* using this function, GTK+ will do its best to convince the window
* manager not to decorate the window. Depending on the system, this
* @setting: %TRUE to decorate the window as deletable
*
* By default, windows have a close button in the window frame. Some
- * <link linkend="gtk-X11-arch">window managers</link> allow GTK+ to
+ * [window managers][gtk-X11-arch] allow GTK+ to
* disable this button. If you set the deletable property to %FALSE
* using this function, GTK+ will do its best to convince the window
* manager not to show a close button. Depending on the system, this
* @height: (out) (allow-none): return location for height, or %NULL
*
* Obtains the current size of @window. If @window is not onscreen,
- * it returns the size GTK+ will suggest to the <link
- * linkend="gtk-X11-arch">window manager</link> for the initial window
+ * it returns the size GTK+ will suggest to the
+ * [window manager][gtk-X11-arch]
+ * for the initial window
* size (but this is not reliably the same as the size the window
* manager will actually select). The size obtained by
* gtk_window_get_size() is the last size received in a
* @x: X coordinate to move window to
* @y: Y coordinate to move window to
*
- * Asks the <link linkend="gtk-X11-arch">window manager</link> to move
+ * Asks the [window manager][gtk-X11-arch] to move
* @window to the given position. Window managers are free to ignore
* this; most window managers ignore requests for initial window
* positions (instead using a user-defined placement algorithm) and
*
* Asks to iconify (i.e. minimize) the specified @window. Note that
* you shouldn't assume the window is definitely iconified afterward,
- * because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could deiconify it
+ * because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could deiconify it
* again, or there may not be a window manager in which case
* iconification isn't possible, etc. But normally the window will end
* up iconified. Just don't write code that crashes if not.
*
* Asks to deiconify (i.e. unminimize) the specified @window. Note
* that you shouldn't assume the window is definitely deiconified
- * afterward, because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could iconify it
+ * afterward, because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch])) could iconify it
* again before your code which assumes deiconification gets to run.
*
* You can track iconification via the “window-state-event” signal
*
* Asks to stick @window, which means that it will appear on all user
* desktops. Note that you shouldn't assume the window is definitely
- * stuck afterward, because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could unstick it
+ * stuck afterward, because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch] could unstick it
* again, and some window managers do not support sticking
* windows. But normally the window will end up stuck. Just don't
* write code that crashes if not.
* Asks to unstick @window, which means that it will appear on only
* one of the user's desktops. Note that you shouldn't assume the
* window is definitely unstuck afterward, because other entities
- * (e.g. the user or <link linkend="gtk-X11-arch">window
- * manager</link>) could stick it again. But normally the window will
+ * (e.g. the user or [window manager][gtk-X11-arch]) could
+ * stick it again. But normally the window will
* end up stuck. Just don't write code that crashes if not.
*
* You can track stickiness via the “window-state-event” signal
*
* Asks to maximize @window, so that it becomes full-screen. Note that
* you shouldn't assume the window is definitely maximized afterward,
- * because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could unmaximize it
+ * because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could unmaximize it
* again, and not all window managers support maximization. But
* normally the window will end up maximized. Just don't write code
* that crashes if not.
*
* Asks to unmaximize @window. Note that you shouldn't assume the
* window is definitely unmaximized afterward, because other entities
- * (e.g. the user or <link linkend="gtk-X11-arch">window
- * manager</link>) could maximize it again, and not all window
+ * (e.g. the user or [window manager][gtk-X11-arch])
+ * could maximize it again, and not all window
* managers honor requests to unmaximize. But normally the window will
* end up unmaximized. Just don't write code that crashes if not.
*
*
* Asks to place @window in the fullscreen state. Note that you
* shouldn't assume the window is definitely full screen afterward,
- * because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could unfullscreen it
+ * because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could unfullscreen it
* again, and not all window managers honor requests to fullscreen
* windows. But normally the window will end up fullscreen. Just
* don't write code that crashes if not.
*
* Asks to toggle off the fullscreen state for @window. Note that you
* shouldn't assume the window is definitely not full screen
- * afterward, because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could fullscreen it
+ * afterward, because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could fullscreen it
* again, and not all window managers honor requests to unfullscreen
* windows. But normally the window will end up restored to its normal
* state. Just don't write code that crashes if not.
*
* Asks to keep @window above, so that it stays on top. Note that
* you shouldn't assume the window is definitely above afterward,
- * because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could not keep it above,
+ * because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could not keep it above,
* and not all window managers support keeping windows above. But
* normally the window will end kept above. Just don't write code
* that crashes if not.
*
* Asks to keep @window below, so that it stays in bottom. Note that
* you shouldn't assume the window is definitely below afterward,
- * because other entities (e.g. the user or <link
- * linkend="gtk-X11-arch">window manager</link>) could not keep it below,
+ * because other entities (e.g. the user or
+ * [window manager][gtk-X11-arch]) could not keep it below,
* and not all window managers support putting windows below. But
* normally the window will be kept below. Just don't write code
* that crashes if not.
*
* Starts resizing a window. This function is used if an application
* has window resizing controls. When GDK can support it, the resize
- * will be done using the standard mechanism for the <link
- * linkend="gtk-X11-arch">window manager</link> or windowing
+ * will be done using the standard mechanism for the
+ * [window manager][gtk-X11-arch] or windowing
* system. Otherwise, GDK will try to emulate window resizing,
* potentially not all that well, depending on the windowing system.
*/
*
* Starts moving a window. This function is used if an application has
* window movement grips. When GDK can support it, the window movement
- * will be done using the standard mechanism for the <link
- * linkend="gtk-X11-arch">window manager</link> or windowing
+ * will be done using the standard mechanism for the
+ * [window manager][gtk-X11-arch] or windowing
* system. Otherwise, GDK will try to emulate window movement,
* potentially not all that well, depending on the windowing system.
*/
projects / gtk4.git / commitdiff